Delete Object
AutomatR.AWS.Activities.DeleteObject
The "Delete Object" activity in AutomatR is part of the AWS S3 (Simple Storage Service) activities package, enabling automation processes to delete single or multiple objects from an Amazon S3 bucket. This activity streamlines object management tasks in AWS S3, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS S3 service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS S3 service. String variables containing the secret access key. |
| Region | Specifies the AWS region associated with the S3 bucket. Use the RegionEndpoint enumeration to set the region. |
| Bucket Name | Specifies the name of the Amazon S3 bucket from which objects will be deleted. String variables containing the bucket name. |
| Path | Specifies the full paths of the objects to be deleted from the bucket. Use a List<String> variable to provide multiple object paths. For example, new List<string> {"deleteobject/deleteobj.zip", "deleteobject1/deleteobj1.zip"}. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Delete Object" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
How to use:
- Drag and drop the "Delete Object" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, bucket name, and object paths.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to delete the specified objects from the Amazon S3 bucket.
Example: Consider an example where the "Delete Object" activity is used to delete two objects ("deleteobject/deleteobj.zip" and "deleteobject1/deleteobj1.zip") from an S3 bucket named "my-s3-bucket" in the "us-east-1" region:
Delete Object:
Display Name: "Delete S3 Objects"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Bucket Name: "my-s3-bucket"
Path: ```new List<string> {"deleteobject/deleteobj.zip", "deleteobject1/deleteobj1.zip"}```
In this example, the activity deletes the specified objects from the "my-s3-bucket" in the "us-east-1" region. The success or failure of the deletion can be handled in subsequent workflow activities.